#インターフェイス: TooltipOptions<TType>

#型パラメータ

名前	タイプ
`TType`	伸びる`ChartType`=`ChartType`

#階層

CoreInteractionOptions

↳TooltipOptions

#プロパティ

#アニメーション

•アニメーション:false|AnimationSpec<TType>

#で定義

タイプ/index.d.ts:2853 (新しいウィンドウが開きます)

#アニメーション

•アニメーション:false|AnimationsSpec<TType>

#で定義

タイプ/index.d.ts:2854 (新しいウィンドウが開きます)

#軸

•軸:InteractionAxis

距離の計算にどの方向が使用されるかを定義します。デフォルトは、「インデックス」モードの場合は「x」、データセットおよび「最近接」モードの場合は「xy」です。

#継承元

コアインタラクションオプション。軸

#で定義

タイプ/index.d.ts:1548 (新しいウィンドウが開きます)

#背景色

•背景色:Scriptable<Color、ScriptableTooltipContext<TType>>

ツールチップの背景色。

Default

'rgba(0, 0, 0, 0.8)'

#で定義

タイプ/index.d.ts:2711 (新しいウィンドウが開きます)

#ボディアライン

•ボディアライン:Scriptable<TextAlign、ScriptableTooltipContext<TType>>

本文テキスト行の水平方向の配置。

Default

'左'

#で定義

タイプ/index.d.ts:2761 (新しいウィンドウが開きます)

#ボディカラー

•ボディカラー:Scriptable<Color、ScriptableTooltipContext<TType>>

ボディの色

Default

「#fff」

#で定義

タイプ/index.d.ts:2751 (新しいウィンドウが開きます)

#本文フォント

•本文フォント:ScriptableAndScriptableOptions<Partial<FontSpec>、ScriptableTooltipContext<TType>>

「フォント」を参照してください。

Default

#で定義

タイプ/index.d.ts:2756 (新しいウィンドウが開きます)

#体の間隔

•体の間隔:Scriptable<number、ScriptableTooltipContext<TType>>

各ツールチップ項目の上部と下部に追加する間隔。

Default

#で定義

タイプ/index.d.ts:2746 (新しいウィンドウが開きます)

#ボーダの色

•ボーダの色:Scriptable<Color、ScriptableTooltipContext<TType>>

境界線の色。

Default

'rgba(0, 0, 0, 0)'

#で定義

タイプ/index.d.ts:2836 (新しいウィンドウが開きます)

#境界線の幅

•境界線の幅:Scriptable<number、ScriptableTooltipContext<TType>>

境界線のサイズ。

Default

#で定義

タイプ/index.d.ts:2841 (新しいウィンドウが開きます)

#ボックスの高さ

•ボックスの高さ:Scriptable<number、ScriptableTooltipContext<TType>>

displayColors が true の場合のカラーボックスの高さ。

Default

bodyFont.size

#で定義

タイプ/index.d.ts:2826 (新しいウィンドウが開きます)

#ボックスパディング

•ボックスパディング:number

カラーボックスとテキストの間のパディング。

Default

#で定義

タイプ/index.d.ts:2716 (新しいウィンドウが開きます)

#ボックスの幅

•ボックスの幅:Scriptable<number、ScriptableTooltipContext<TType>>

displayColors が true の場合のカラーボックスの幅。

Default

bodyFont.size

#で定義

タイプ/index.d.ts:2821 (新しいウィンドウが開きます)

#コールバック

•コールバック:TooltipCallbacks<TType、TooltipModel<TType>、TooltipItem<TType>>

#で定義

タイプ/index.d.ts:2855 (新しいウィンドウが開きます)

#キャレットパディング

•キャレットパディング:Scriptable<number、ScriptableTooltipContext<TType>>

ツールチップの矢印の端をツールチップの点から遠ざけるための追加の距離。

Default

#で定義

タイプ/index.d.ts:2796 (新しいウィンドウが開きます)

#キャレットサイズ

•キャレットサイズ:Scriptable<number、ScriptableTooltipContext<TType>>

ツールチップの矢印のサイズ (ピクセル単位)。

Default

#で定義

タイプ/index.d.ts:2801 (新しいウィンドウが開きます)

#コーナー半径

•コーナー半径:Scriptable<number|BorderRadius、ScriptableTooltipContext<TType>>

ツールチップのコーナーカーブの半径。

Default

#で定義

タイプ/index.d.ts:2806 (新しいウィンドウが開きます)

#ディスプレイの色

•ディスプレイの色:Scriptable<boolean、ScriptableTooltipContext<TType>>

true の場合、ツールチップにカラーボックスが表示されます。

Default

真実

#で定義

タイプ/index.d.ts:2816 (新しいウィンドウが開きます)

#有効

•有効:Scriptable<boolean、ScriptableTooltipContext<TType>>

キャンバス上のツールチップは有効になっていますか?

Default

真実

#で定義

タイプ/index.d.ts:2684 (新しいウィンドウが開きます)

#フィルター

•フィルター:(e:TooltipItem<TType>、index:number、array:TooltipItem<TType>[]、data:ChartData<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown>) =>boolean

#型宣言

▸ (e、index、array、data):boolean

#パラメーター

名前	タイプ
`e`	`TooltipItem`<`TType`>
`index`	`number`
`array`	`TooltipItem`<`TType`>[]
`data`	`ChartData`<キーオフ`ChartTypeRegistry`、（`number`\| [`number`、`number`] \|`Point`\|`BubbleDataPoint`)[]、`unknown`>

#戻り値

boolean

#で定義

タイプ/index.d.ts:2705 (新しいウィンドウが開きます)

#フッター整列

•フッター整列:Scriptable<TextAlign、ScriptableTooltipContext<TType>>

フッターテキスト行の水平方向の配置。

Default

'左'

#で定義

タイプ/index.d.ts:2786 (新しいウィンドウが開きます)

#フッターの色

•フッターの色:Scriptable<Color、ScriptableTooltipContext<TType>>

フッターの色

Default

「#fff」

#で定義

タイプ/index.d.ts:2776 (新しいウィンドウが開きます)

#フッターフォント

•フッターフォント:ScriptableAndScriptableOptions<Partial<FontSpec>、ScriptableTooltipContext<TType>>

フォントを参照

Default

#で定義

タイプ/index.d.ts:2781 (新しいウィンドウが開きます)

#フッターマージン上

•フッターマージン上:Scriptable<number、ScriptableTooltipContext<TType>>

フッターを描画する前に追加するマージン。

Default

#で定義

タイプ/index.d.ts:2771 (新しいウィンドウが開きます)

#フッター間隔

•フッター間隔:Scriptable<number、ScriptableTooltipContext<TType>>

各フッター行の上部と下部に追加するスペース。

Default

#で定義

タイプ/index.d.ts:2766 (新しいウィンドウが開きます)

#不可視を含む

•不可視を含む:boolean

true の場合、インタラクションを評価するときに、チャート領域の外側にある非表示のポイントも含まれます。

Default

間違い

#継承元

コアインタラクションオプション。不可視を含む

#で定義

タイプ/index.d.ts:1554 (新しいウィンドウが開きます)

#交差する

•交差する:boolean

true の場合、ホバーモードは、マウスの位置がチャート上の項目と交差する場合にのみ適用されます。

Default

真実

#継承元

コアインタラクションオプション。交差する

#で定義

タイプ/index.d.ts:1543 (新しいウィンドウが開きます)

#項目並べ替え

•項目並べ替え:(a:TooltipItem<TType>、b:15829d6a-a416-4d86-a37a-466cf1046料金<TType>、data:ChartData<キーオフChartTypeRegistry、（number| [number、number] |Point|BubbleDataPoint)[]、unknown>) =>number

#型宣言

▸ (a、b、data):number

ツールチップ項目を並べ替えます。

#パラメーター

名前	タイプ
`a`	`TooltipItem`<`TType`>
`b`	`TooltipItem`<`TType`>
`data`	`ChartData`<キーオフ`ChartTypeRegistry`、（`number`\| [`number`、`number`] \|`Point`\|`BubbleDataPoint`)[]、`unknown`>

#戻り値

number

#で定義

タイプ/index.d.ts:2703 (新しいウィンドウが開きます)

#モード

•モード: キーオフInteractionModeMap

ツールチップに表示される要素を設定します。詳細については、「対話モード」を参照してください。

Default

「最も近い」

#継承元

コアインタラクションオプション。モード

#で定義

タイプ/index.d.ts:1538 (新しいウィンドウが開きます)

#マルチキー背景

•マルチキー背景:Scriptable<Color、ScriptableTooltipContext<TType>>

ツールチップに複数の項目がある場合に、色付きボックスの後ろに描画する色。

Default

「#fff」

#で定義

タイプ/index.d.ts:2811 (新しいウィンドウが開きます)

#パディング

•パディング:Scriptable<Padding、ScriptableTooltipContext<TType>>

ツールチップに追加するパディング

Default

#で定義

タイプ/index.d.ts:2791 (新しいウィンドウが開きます)

#位置

•位置:Scriptable<キーオフTooltipPositionerMap、ScriptableTooltipContext<TType>>

ツールチップを配置するモード

#で定義

タイプ/index.d.ts:2692 (新しいウィンドウが開きます)

#rtl

•rtl:Scriptable<boolean、ScriptableTooltipContext<TType>>

凡例を右から左にレンダリングする場合は true。

#で定義

タイプ/index.d.ts:2845 (新しいウィンドウが開きます)

#テキスト方向

•テキスト方向:Scriptable<string、ScriptableTooltipContext<TType>>

これにより、キャンバス上で指定された CSS に関係なく、ツールチップをレンダリングするためにキャンバス上でテキスト方向「rtl」または「ltr」が強制されます。

Default

キャンバスのデフォルト

#で定義

タイプ/index.d.ts:2851 (新しいウィンドウが開きます)

#タイトル整列

•タイトル整列:Scriptable<TextAlign、ScriptableTooltipContext<TType>>

タイトルテキスト行の水平方向の配置。

Default

'左'

#で定義

タイプ/index.d.ts:2741 (新しいウィンドウが開きます)

#タイトル色

•タイトル色:Scriptable<Color、ScriptableTooltipContext<TType>>

タイトルの色

Default

「#fff」

#で定義

タイプ/index.d.ts:2721 (新しいウィンドウが開きます)

#タイトルフォント

•タイトルフォント:ScriptableAndScriptableOptions<Partial<FontSpec>、ScriptableTooltipContext<TType>>

フォントを参照

Default

#で定義

タイプ/index.d.ts:2726 (新しいウィンドウが開きます)

#タイトル余白下

•タイトル余白下:Scriptable<number、ScriptableTooltipContext<TType>>

タイトルセクションの下部に追加するマージン。

Default

#で定義

タイプ/index.d.ts:2736 (新しいウィンドウが開きます)

#タイトル間隔

•タイトル間隔:Scriptable<number、ScriptableTooltipContext<TType>>

各タイトル行の上下に追加するスペース。

Default

#で定義

タイプ/index.d.ts:2731 (新しいウィンドウが開きます)

#usePointStyle

•usePointStyle:Scriptable<boolean、ScriptableTooltipContext<TType>>

カラーボックスの代わりに、対応するポイントスタイル (データセットオプションから) を使用します (例: 星、三角形など) (サイズは boxWidth と boxHeight の間の最小値に基づきます)。

Default

間違い

#で定義

タイプ/index.d.ts:2831 (新しいウィンドウが開きます)

#xAlign

•xAlign:Scriptable<TooltipXAlignment、ScriptableTooltipContext<TType>>

ツールチップの配置計算をオーバーライドする

#で定義

タイプ/index.d.ts:2697 (新しいウィンドウが開きます)

#y整列

•y整列:Scriptable<TooltipYAlignment、ScriptableTooltipContext<TType>>

#で定義

タイプ/index.d.ts:2698 (新しいウィンドウが開きます)

#メソッド

#外部の

▸外部の(this、args):void

外部ツールチップのセクションを参照してください。

#パラメーター

名前	タイプ
`this`	`TooltipModel`<`TType`>
`args`	`Object`
`args.chart`	`Chart`<キーオフ`ChartTypeRegistry`、（`number`\| [`number`、`number`] \|`Point`\|`BubbleDataPoint`)[]、`unknown`>
`args.tooltip`	`TooltipModel`<`TType`>

#戻り値

void

#で定義

タイプ/index.d.ts:2688 (新しいウィンドウが開きます)

←ツールチップモデルツールチップの位置→